Add a section on how to run a development instance of EasyBuild #260
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ocaisa
requested changes
Jun 16, 2025
| ``` | ||
|
|
||
| To run the development instance, you need to add the framework and easyblocks | ||
| directories in the Python path, and the easyconfigs in the robot search path. |
There was a problem hiding this comment.
Suggested change
| directories in the Python path, and the easyconfigs in the robot search path. | |
| directories in the Python path, and the easyconfigs to the robot search path. |
| EasyBuild as follows: | ||
|
|
||
| ```bash | ||
| alias eb="PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --robot-paths=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs:" |
There was a problem hiding this comment.
Suggested change
| alias eb="PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --robot-paths=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs:" | |
| alias eb_devel="PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --robot-paths=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs:" |
Rather than suggest to shadow the eb command, maybe make it explicit that you want the development version.
| ```bash | ||
| alias eb="PYTHONPATH=/path/to/EasyBuild/easybuild-framework:/path/to/EasyBuild/easybuild-easyblocks:${PYTHONPATH} /path/to/EasyBuild/easybuild-framework/eb --robot-paths=/path/to/EasyBuild/easybuild-easyconfigs/easybuild/easyconfigs:" | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Suggested change
| `--robot-paths` updates the paths accessible to easybuild for searching, the `:` at the end of the value indicates to EasyBuild to retain it's default robot search paths. This approach still allows for further customisation via `--robot`. | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There seems to be no official instruction on how to run a local instance of EasyBuild. I added a few notes in the contributor page.